[Instances] Partially update compute instance metadata

curl --request PATCH \
  --url https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "tags": [
    "<string>"
  ],
  "vpc_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}"

payload = {
    "name": "<string>",
    "tags": ["<string>"],
    "vpc_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    tags: ['<string>'],
    vpc_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'tags' => [
        '<string>'
    ],
    'vpc_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"vpc_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"vpc_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"vpc_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "pending",
  "size": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "vcpu": 2147483647,
    "ram_mb": 2147483647,
    "bandwidth_mbps": 2147483647,
    "available_volumes": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "volume_type": "ssd",
        "disk_gb": 2147483647,
        "is_default": true,
        "is_active": true
      }
    ],
    "pricing_options": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "billing_cycle": "hourly",
        "price": "<string>",
        "discount_percent": "<string>",
        "is_default": true,
        "is_active": true
      }
    ],
    "available_addons": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "addon": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "name": "<string>",
          "name_fr": "<string>",
          "name_de": "<string>",
          "description": "<string>",
          "description_fr": "<string>",
          "description_de": "<string>",
          "billing_type": "recurring",
          "is_active": true
        },
        "pricing_options": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "billing_cycle": "hourly",
            "price": "<string>",
            "is_active": true
          }
        ],
        "is_included": true,
        "is_default": true,
        "is_active": true
      }
    ],
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "cpu_model": "e5-2680-v4",
    "is_active": true,
    "description": "<string>"
  },
  "location": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "country_code": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "is_active": true
  },
  "vpc": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "cidr_block": "<string>",
    "location": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "slug": "<string>",
      "country_code": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "modified": "2023-11-07T05:31:56Z",
      "is_active": true
    },
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "is_active": true
  },
  "image": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "os_name": "<string>",
    "os_version": "<string>",
    "language": "<string>",
    "is_windows": true,
    "requires_license_addon": true,
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "visibility": "public",
    "os_architecture": "<string>",
    "is_active": true,
    "is_featured": true,
    "min_disk_gb": 2147483647,
    "min_ram_mb": 2147483647
  },
  "os_name": "<string>",
  "primary_ipv4": "<string>",
  "primary_ipv6": "<string>",
  "ip_addresses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "address": "<string>",
      "ip_type": "ipv4",
      "interface": 123,
      "netmask": "<string>",
      "gateway": "<string>",
      "network_range": "<string>",
      "mac_address": "<string>",
      "is_primary": true,
      "created": "2023-11-07T05:31:56Z",
      "modified": "2023-11-07T05:31:56Z",
      "reverse_dns": "<string>"
    }
  ],
  "volume_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "volumes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "size_gb": 123,
      "status": "pending",
      "disk_type": "ssd",
      "location": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "slug": "<string>",
        "country_code": "<string>",
        "created": "2023-11-07T05:31:56Z",
        "modified": "2023-11-07T05:31:56Z",
        "is_active": true
      },
      "price_monthly": "<string>",
      "is_active": true,
      "created": "2023-11-07T05:31:56Z"
    }
  ],
  "billing_cycle": "free",
  "recurring_amount": "<string>",
  "billing_start_date": "2023-11-07T05:31:56Z",
  "billing_end_date": "2023-11-07T05:31:56Z",
  "next_billing_date": "2023-11-07T05:31:56Z",
  "cancellation_requested_at": "2023-11-07T05:31:56Z",
  "cancellation_reason": "<string>",
  "cancellation_reason_code": "too_expensive",
  "bandwidth_used_gb": "<string>",
  "is_active": true,
  "is_installed": true,
  "snapshot_enabled": true,
  "snapshot_billing": {},
  "backup_enabled": true,
  "control_panel": {
    "name": "<string>",
    "slug": "<string>",
    "status": "pending",
    "access_url": "<string>",
    "instructions": "<string>",
    "docs_url": "<string>",
    "install_minutes_min": 123,
    "install_minutes_max": 123,
    "has_credentials": true
  },
  "active_addons": [
    {}
  ],
  "can_run_windows": true,
  "gpu_capable": true,
  "state_sync": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vm_status": "running",
    "last_synced_at": "2023-11-07T05:31:56Z",
    "uptime": 2147483647,
    "cpu_usage": "<string>",
    "memory_usage_mb": 2147483647,
    "disk_usage_gb": "<string>",
    "network_in_bytes": 0,
    "network_out_bytes": 0
  },
  "agent_info": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_available": true,
    "os_id": "<string>",
    "os_name": "<string>",
    "os_pretty_name": "<string>",
    "os_version": "<string>",
    "kernel_release": "<string>",
    "kernel_version": "<string>",
    "machine": "<string>",
    "hostname": "<string>",
    "timezone": "<string>",
    "filesystems": "<unknown>",
    "network_interfaces": "<unknown>",
    "users": "<unknown>",
    "last_collected_at": "2023-11-07T05:31:56Z"
  },
  "locked": true,
  "lock_reason": "backup",
  "created": "2023-11-07T05:31:56Z",
  "modified": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ]
}

PATCH

organizations

{organization_id}

projects

{project_id}

compute

instances

{id}

[Instances] Partially update compute instance metadata

curl --request PATCH \
  --url https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "tags": [
    "<string>"
  ],
  "vpc_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}"

payload = {
    "name": "<string>",
    "tags": ["<string>"],
    "vpc_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    tags: ['<string>'],
    vpc_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'tags' => [
        '<string>'
    ],
    'vpc_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"vpc_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"vpc_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"vpc_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "pending",
  "size": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "vcpu": 2147483647,
    "ram_mb": 2147483647,
    "bandwidth_mbps": 2147483647,
    "available_volumes": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "volume_type": "ssd",
        "disk_gb": 2147483647,
        "is_default": true,
        "is_active": true
      }
    ],
    "pricing_options": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "billing_cycle": "hourly",
        "price": "<string>",
        "discount_percent": "<string>",
        "is_default": true,
        "is_active": true
      }
    ],
    "available_addons": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "addon": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "name": "<string>",
          "name_fr": "<string>",
          "name_de": "<string>",
          "description": "<string>",
          "description_fr": "<string>",
          "description_de": "<string>",
          "billing_type": "recurring",
          "is_active": true
        },
        "pricing_options": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "billing_cycle": "hourly",
            "price": "<string>",
            "is_active": true
          }
        ],
        "is_included": true,
        "is_default": true,
        "is_active": true
      }
    ],
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "cpu_model": "e5-2680-v4",
    "is_active": true,
    "description": "<string>"
  },
  "location": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "country_code": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "is_active": true
  },
  "vpc": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "cidr_block": "<string>",
    "location": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "slug": "<string>",
      "country_code": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "modified": "2023-11-07T05:31:56Z",
      "is_active": true
    },
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "is_active": true
  },
  "image": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "os_name": "<string>",
    "os_version": "<string>",
    "language": "<string>",
    "is_windows": true,
    "requires_license_addon": true,
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "visibility": "public",
    "os_architecture": "<string>",
    "is_active": true,
    "is_featured": true,
    "min_disk_gb": 2147483647,
    "min_ram_mb": 2147483647
  },
  "os_name": "<string>",
  "primary_ipv4": "<string>",
  "primary_ipv6": "<string>",
  "ip_addresses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "address": "<string>",
      "ip_type": "ipv4",
      "interface": 123,
      "netmask": "<string>",
      "gateway": "<string>",
      "network_range": "<string>",
      "mac_address": "<string>",
      "is_primary": true,
      "created": "2023-11-07T05:31:56Z",
      "modified": "2023-11-07T05:31:56Z",
      "reverse_dns": "<string>"
    }
  ],
  "volume_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "volumes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "size_gb": 123,
      "status": "pending",
      "disk_type": "ssd",
      "location": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "slug": "<string>",
        "country_code": "<string>",
        "created": "2023-11-07T05:31:56Z",
        "modified": "2023-11-07T05:31:56Z",
        "is_active": true
      },
      "price_monthly": "<string>",
      "is_active": true,
      "created": "2023-11-07T05:31:56Z"
    }
  ],
  "billing_cycle": "free",
  "recurring_amount": "<string>",
  "billing_start_date": "2023-11-07T05:31:56Z",
  "billing_end_date": "2023-11-07T05:31:56Z",
  "next_billing_date": "2023-11-07T05:31:56Z",
  "cancellation_requested_at": "2023-11-07T05:31:56Z",
  "cancellation_reason": "<string>",
  "cancellation_reason_code": "too_expensive",
  "bandwidth_used_gb": "<string>",
  "is_active": true,
  "is_installed": true,
  "snapshot_enabled": true,
  "snapshot_billing": {},
  "backup_enabled": true,
  "control_panel": {
    "name": "<string>",
    "slug": "<string>",
    "status": "pending",
    "access_url": "<string>",
    "instructions": "<string>",
    "docs_url": "<string>",
    "install_minutes_min": 123,
    "install_minutes_max": 123,
    "has_credentials": true
  },
  "active_addons": [
    {}
  ],
  "can_run_windows": true,
  "gpu_capable": true,
  "state_sync": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vm_status": "running",
    "last_synced_at": "2023-11-07T05:31:56Z",
    "uptime": 2147483647,
    "cpu_usage": "<string>",
    "memory_usage_mb": 2147483647,
    "disk_usage_gb": "<string>",
    "network_in_bytes": 0,
    "network_out_bytes": 0
  },
  "agent_info": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_available": true,
    "os_id": "<string>",
    "os_name": "<string>",
    "os_pretty_name": "<string>",
    "os_version": "<string>",
    "kernel_release": "<string>",
    "kernel_version": "<string>",
    "machine": "<string>",
    "hostname": "<string>",
    "timezone": "<string>",
    "filesystems": "<unknown>",
    "network_interfaces": "<unknown>",
    "users": "<unknown>",
    "last_collected_at": "2023-11-07T05:31:56Z"
  },
  "locked": true,
  "lock_reason": "backup",
  "created": "2023-11-07T05:31:56Z",
  "modified": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer <token> header. Token can be a JWT token or an API key (format: sk-onetsolutions-...).

Path Parameters

string<uuid>

required

A UUID string identifying this Instance.

organization_id

string

required

Unique identifier of the organization that owns the resource.

project_id

string

required

Unique identifier of the project containing the resource.

Body

application/json

name

string

Maximum string length: 253

Pattern: ^(?=.{1,253}$)(?!-)[A-Za-z0-9-]{1,63}(?<!-)(\.(?!-)[A-Za-z0-9-]{1,63}(?<!-))*$

Response

Instance updated successfully

string<uuid>

required

read-only

organization_id

string<uuid>

required

read-only

project_id

string<uuid>

required

read-only

name

string

required

Instance hostname

Maximum string length: 255

status

enum<string>

required

read-only

Billing status

pending - Pending
provisioning - Provisioning
active - Active
suspended - Suspended
terminated - Terminated
cancelled - Cancelled
error - Error

Available options:

pending,

provisioning,

active,

suspended,

terminated,

cancelled,

error

size

object

required

Show child attributes

location

object

required

Show child attributes

vpc

object

required

Show child attributes

image

object

required

Show child attributes

os_name

string

required

read-only

Operating system name

primary_ipv4

string | null

required

read-only

primary_ipv6

string | null

required

read-only

ip_addresses

object[]

required

read-only

Show child attributes

volume_config_id

string<uuid> | null

required

read-only

volumes

object[]

required

read-only

Show child attributes

billing_cycle

enum<string>

required

read-only

free - Free
one_time - One Time
hourly - Hourly
monthly - Monthly
quarterly - Quarterly
semi_annually - Semi-Annually
annually - Annually
biennially - Biennially
triennially - Triennially

Available options:

free,

one_time,

hourly,

monthly,

quarterly,

semi_annually,

annually,

biennially,

triennially

recurring_amount

string | null

required

read-only

Amount billed at each renewal

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

billing_start_date

string<date-time>

required

read-only

billing_end_date

string<date-time> | null

required

read-only

For prepaid only

next_billing_date

string<date-time> | null

required

read-only

cancellation_requested_at

string<date-time> | null

required

read-only

When cancellation was requested, effective at billing_end_date

cancellation_reason

string

required

read-only

Reason provided for cancellation request

cancellation_reason_code

enum<string>

required

read-only

Reason picked for cancellation

too_expensive - Too expensive
no_longer_needed - No longer needed
missing_feature - Missing feature
technical_issue - Technical issue
switching_provider - Moving to another provider
other - Other

Available options:

too_expensive,

no_longer_needed,

missing_feature,

technical_issue,

switching_provider,

other

bandwidth_used_gb

string

required

read-only

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$

is_active

boolean

required

read-only

is_installed

boolean

required

read-only

Whether the instance OS/service has been installed

snapshot_enabled

boolean

required

read-only

Snapshot option active on the service

snapshot_billing

object

required

read-only

Show child attributes

backup_enabled

boolean

required

read-only

Backup option active on the service

control_panel

object | null

required

Show child attributes

active_addons

object[]

required

read-only

Show child attributes

can_run_windows

boolean

required

read-only

gpu_capable

boolean

required

read-only

state_sync

object

required

Show child attributes

agent_info

object

required

Show child attributes

locked

boolean

required

read-only

lock_reason

enum<string> | null

required

read-only

backup - Backup
restore - Restore
snapshot - Snapshot
migration - Migration
other - Other

Available options:

backup,

restore,

snapshot,

migration,

other,

null

created

string<date-time>

required

read-only

modified

string<date-time>

required

read-only

Authentication

Compute

Domains

Web Hosting

Organizations

Billing

Projects

[Instances] Partially update compute instance metadata

Authorizations

Path Parameters

Body

Response